/*
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 *
 * This software is open source.
 * See the bottom of this file for the licence.
 */

package org.dom4j;

import java.io.PrintStream;
import java.io.PrintWriter;

/**
 * <p> <code>DocumentException</code> is a nested Exception which may be
 * thrown during the processing of a DOM4J document. </p>
 * 
 * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
 * @version $Revision: 1.2 $
 */
public class DocumentException extends Exception
{
   /** A wrapped <code>Throwable</code> */
   private Throwable nestedException;

   public DocumentException()
   {
      super("Error occurred in DOM4J application.");
   }

   public DocumentException(String message)
   {
      super(message);
   }

   public DocumentException(Throwable nestedException)
   {
      super(nestedException.getMessage());
      this.nestedException = nestedException;
   }

   public DocumentException(String message, Throwable nestedException)
   {
      super(message);
      this.nestedException = nestedException;
   }

   public Throwable getNestedException()
   {
      return nestedException;
   }

   public String getMessage()
   {
      if(nestedException != null)
      {
         return super.getMessage() + " Nested exception: "
            + nestedException.getMessage();
      }
      else
      {
         return super.getMessage();
      }
   }

   public void printStackTrace()
   {
      super.printStackTrace();

      if(nestedException != null)
      {
         System.err.print("Nested exception: ");
         nestedException.printStackTrace();
      }
   }

   public void printStackTrace(PrintStream out)
   {
      super.printStackTrace(out);

      if(nestedException != null)
      {
         out.println("Nested exception: ");
         nestedException.printStackTrace(out);
      }
   }

   public void printStackTrace(PrintWriter writer)
   {
      super.printStackTrace(writer);

      if(nestedException != null)
      {
         writer.println("Nested exception: ");
         nestedException.printStackTrace(writer);
      }
   }
}

/*
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided that the
 * following conditions are met:
 * 
 * 1. Redistributions of source code must retain copyright statements and
 * notices. Redistributions must also contain a copy of this document.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * 3. The name "DOM4J" must not be used to endorse or promote products derived
 * from this Software without prior written permission of MetaStuff, Ltd. For
 * written permission, please contact dom4j-info@metastuff.com.
 * 
 * 4. Products derived from this Software may not be called "DOM4J" nor may
 * "DOM4J" appear in their names without prior written permission of MetaStuff,
 * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
 * 
 * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
 * 
 * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 */
